Update doc by Florian-Merle · Pull Request #258 · Sylius/Stack

Florian-Merle · 2025-05-01T09:38:49Z

This PR is a follow-up to these comments:

diimpp · 2025-05-01T12:39:23Z

docs/cookbook/admin_panel/menu.md

+
+### Opening a link in a new tab
+
+Target blank directive can be added to link that either are top level menu items without children or children items. In other words this can be configured to item that do not have children.


Suggested change

Target blank directive can be added to link that either are top level menu items without children or children items. In other words this can be configured to item that do not have children.

Target blank directive can be added to links that either are top-level menu items without children or children items. In other words, this can be configured to items that do not have children.

I think this sentence is redundant with the next one on line 98 - I think we should delete this one entirely up to line 96 and only keep the line 98 one which is much better.

I updated the doc like @stlgaits suggested

diimpp · 2025-05-01T12:42:49Z

docs/cookbook/admin_panel/menu.md

+    {
+        $menu = $this->factory->createItem('root');
+        // ...
+        $this->aaddApiDocMenuddApiDocMenu($menu);


Suggested change

$this->aaddApiDocMenuddApiDocMenu($menu);

$this->addApiDocMenu($menu);

But if we're to follow existing examples, this should be named submenu instead.

Suggested change

$this->aaddApiDocMenuddApiDocMenu($menu);

$this->addApiDocSubMenu($menu);

diimpp · 2025-05-01T12:46:18Z

docs/cookbook/admin_panel/menu.md

+    private function addApiDocMenu(ItemInterface $menu): void
+    {
+        $library = $menu
+            ->addChild('api_doc', [
+                'route' => 'api_doc',
+            ])
+            ->setLabel('app.ui.api_doc')
+            ->setLabelAttribute('icon', 'tabler:api')
+            ->setLinkAttribute('target', '_blank') // Opens the link in a new tab
+        ;
+    }


Suggested change

private function addApiDocMenu(ItemInterface $menu): void

{

$library = $menu

->addChild('api_doc', [

'route' => 'api_doc',

])

->setLabel('app.ui.api_doc')

->setLabelAttribute('icon', 'tabler:api')

->setLinkAttribute('target', '_blank') // Opens the link in a new tab

;

}

private function addApiDocSubMenu(ItemInterface $menu): void

{

$apiDoc = $menu

->addChild('api_doc', [

'route' => 'api_doc',

])

->setLabel('app.ui.api_doc')

->setLabelAttribute('icon', 'tabler:api')

->setLinkAttribute('target', '_blank') // Opens the link in a new tab

;

}

diimpp · 2025-05-01T12:46:26Z

docs/cookbook/admin_panel/menu.md

+}
+```
+
+>>>>>>> Stashed changes


Suggested change

>>>>>>> Stashed changes

diimpp · 2025-05-01T12:47:21Z

docs/cookbook/admin_panel/page_titles.md

+{% tabs %}
+{% tab title="YAML" %}
+{% code title="config/packages/sylius_bootstrap_admin_ui.yaml" lineNumbers="true" %}
+```yaml


Would be cool to have php example as well.

Indeed, and maybe a small screeenshot of the browser tab as well to make it extra explicit?

diimpp · 2025-05-01T12:47:40Z

docs/cookbook/admin_panel/page_titles.md

+{% endcode %}
+{% endtab %}
+
+


Suggested change

diimpp · 2025-05-01T12:52:08Z

docs/cookbook/admin_panel/menu.md

+        return $menu;
+    }
+
+    private function addApiDocMenu(ItemInterface $menu): void


Personally, I would prefer some other example external submenu/url name than api doc, something in line with books and library from test app and other example snippets.

WDYT @loic425 @stlgaits

Yes good point to try to remain in userland - possibly an external link to the bookstore's website / blog or to something related to the books ecosystem like Goodreads new releases for instance (e.g. https://www.goodreads.com/book/popular_by_date/2025/5?ref=nav_brws_newrels) ?

I changed it to a link to the website homepage. This is not in the test app, but we've got something similar in Sylius/Sylius

stlgaits · 2025-05-05T07:55:56Z

docs/cookbook/admin_panel/page_titles.md

+{% tabs %}
+{% tab title="YAML" %}
+{% code title="config/packages/sylius_bootstrap_admin_ui.yaml" lineNumbers="true" %}
+```yaml


Indeed, and maybe a small screeenshot of the browser tab as well to make it extra explicit?

stlgaits · 2025-05-05T09:27:45Z

docs/cookbook/admin_panel/menu.md

+
+### Opening a link in a new tab
+
+Target blank directive can be added to link that either are top level menu items without children or children items. In other words this can be configured to item that do not have children.


I think this sentence is redundant with the next one on line 98 - I think we should delete this one entirely up to line 96 and only keep the line 98 one which is much better.

stlgaits · 2025-05-05T09:31:32Z

docs/cookbook/admin_panel/menu.md

+
+Target blank directive can be added to link that either are top level menu items without children or children items. In other words this can be configured to item that do not have children.
+
+This can be configured by setting a link attribute on a menu item:


Suggested change

This can be configured by setting a link attribute on a menu item:

stlgaits · 2025-05-05T09:32:18Z

docs/cookbook/admin_panel/menu.md

+
+### Opening a link in a new tab
+
+Target blank directive can be added to link that either are top level menu items without children or children items. In other words this can be configured to item that do not have children.


Suggested change

Target blank directive can be added to link that either are top level menu items without children or children items. In other words this can be configured to item that do not have children.

stlgaits · 2025-05-05T09:34:27Z

docs/cookbook/admin_panel/menu.md

+You can make a link open in a new browser tab by adding the `target="_blank"` link attribute to menu items. This can be applied to top-level menu items without children, or to child items themselves. In other words, it only works for items that do not have submenus.
+
+To configure this behavior, set the target link attribute on the menu item as shown below:
+


Suggested change

{% code title="src/Menu/MenuBuilder.php" lineNumbers="true" %}

stlgaits · 2025-05-05T09:34:52Z

docs/cookbook/admin_panel/menu.md

+    }
+}
+```
+


Suggested change

{% endcode %}

stlgaits · 2025-05-05T09:44:30Z

docs/cookbook/admin_panel/menu.md

+        return $menu;
+    }
+
+    private function addApiDocMenu(ItemInterface $menu): void


Yes good point to try to remain in userland - possibly an external link to the bookstore's website / blog or to something related to the books ecosystem like Goodreads new releases for instance (e.g. https://www.goodreads.com/book/popular_by_date/2025/5?ref=nav_brws_newrels) ?

diimpp reviewed May 1, 2025

View reviewed changes

stlgaits requested changes May 5, 2025

View reviewed changes

Update doc

dd37327

Florian-Merle force-pushed the doc branch from 1d25bca to dd37327 Compare May 7, 2025 12:14

loic425 force-pushed the main branch from e8b281d to 5e656aa Compare September 23, 2025 08:51

stlgaits added the documentation Improvements or additions to documentation label Oct 15, 2025


		### Opening a link in a new tab

		Target blank directive can be added to link that either are top level menu items without children or children items. In other words this can be configured to item that do not have children.

	$this->aaddApiDocMenuddApiDocMenu($menu);
	$this->addApiDocMenu($menu);

	$this->aaddApiDocMenuddApiDocMenu($menu);
	$this->addApiDocSubMenu($menu);


		Target blank directive can be added to link that either are top level menu items without children or children items. In other words this can be configured to item that do not have children.

		This can be configured by setting a link attribute on a menu item:

		You can make a link open in a new browser tab by adding the `target="_blank"` link attribute to menu items. This can be applied to top-level menu items without children, or to child items themselves. In other words, it only works for items that do not have submenus.

		To configure this behavior, set the target link attribute on the menu item as shown below:


	{% code title="src/Menu/MenuBuilder.php" lineNumbers="true" %}

Conversation

Florian-Merle commented May 1, 2025

Uh oh!

diimpp May 1, 2025 • edited by stlgaits Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

diimpp May 1, 2025 •

edited by stlgaits

Loading